Skip to main content

API Direct Debit - Payment Status

Berfungsi untuk melakukan pengecekan status debit

Service Info

HTTP MethodPOST
Service Code55
Http MethodPOST
Path...{version}/debit/status
Header NameTipe DataWajibDeskripsi
Content-TypeStringYapplication/json
AuthorizationStringYMewakili access_token dari sebuah permintaan; string dimulai dengan kata kunci Bearer diikuti oleh access_token (contoh: Bearer eyJraWQiOi...Jzc29zIiwiY).
Authorization-CustomerStringYMewakili access_token dari pelanggan; string dimulai dengan kata kunci Bearer diikuti oleh access_token (contoh: Bearer eyJrsWaiOi...Jzc523awiY).
X-TIMESTAMPStringYWaktu lokal klien saat ini dalam format yyyy-MM-ddTHH:mm:ss+07:00.
X-SIGNATUREStringYX-Signature menggunakan algoritma symmetric signature HMAC_SHA512. Formula stringToSign adalah HTTPMethod + ":" + EndpointUrl + ":" + AccessToken + ":" + Lowercase(HexEncode(SHA-256(minify(RequestBody)))) + ":" + TimeStamp.
X-PARTNER-IDStringYClient ID (diberikan pada saat onboarding).
X-EXTERNAL-IDStringYNomor referensi yang harus unik pada hari yg sama, disarankan menggunakan UUID v4.
X-DEVICE-IDStringYIdentifikasi perangkat dimana layanan API sedang diakses oleh pengguna akhir (customer).
CHANNEL-IDStringY00001 untuk PJP dan 00002 untuk non PJP.

Body

ParameterTipe DataWajibDeskripsi
originalPartnerReferenceNoStringYPengidentifikasi transaksi asli pada sistem konsumen layanan
Length: <= 64 karakter
originalReferenceNoStringYPengidentifikasi transaksi pada sistem penyedia layanan
Length: <= 64 karakter
serviceCodeStringYKode layanan dari layanan yang akan diakses
Length: <= 2 karakter
merchantIdStringYPengidentifikasi merchant pada sistem penyedia layanan
Length: <= 64 karakter
additionalInfoObjectYInformasi Tambahan

Request samples

{
"originalPartnerReferenceNo": "2020102900000000000001",
"originalReferenceNo": "5037424",
"serviceCode": "50",
"merchantId": "1212723",
"additionalInfo": {
"deviceId": "12345679237",
"channel": "mobilephone"
}
}
```

Response Structure

ParameterTipe DataDeskripsi
responseCodeStringKode respons
Length: <= 7 karakter
responseMessageStringDeskripsi respons
Length: <= 150 karakter
originalReferenceNoStringPengidentifikasi transaksi asli pada penyedia layanan
Length: <= 64 karakter
serviceCodeStringPengidentifikasi transaksi pada sistem konsumen layanan
Length: <= 32 karakter
latestTransactionStatusStringStatus transaksi terakhir
00 - berhasil, 07 - tidak ditemukan
Length: <= 2 karakter
transactionStatusDescStringDeskripsi status transaksi
Length: <= 50 karakter
amountObjectJumlah
paidTimeStringTanggal transaksi dalam format ISO 8601
Length: <= 25 karakter

Response samples

{
"responseCode": "2005500",
"responseMessage": "Successful",
"originalReferenceNo": "5037424",
"latestTransactionStatus": "00",
"transactionStatusDesc": "Success",
"amount": {
"value": "65000.00",
"currency": "IDR"
},
"paidTime": "2023-01-27T17:28:00.667+07:00"
}

List Response Code API Direct Debit - Payment Status

Response CodeResponse MessageDescription
2005500SuccessSukses
4005501Invalid field format { field name }Format invalid
4005502Invalid mandatory field {field name}Format pada bidang wajib tidak ada atau tidak valid
4015500Unauthorized. Invalid SignatureX-Signature salah
4095500Cannot use same X-EXTERNAL-ID in same dayX-External-ID sudah pernah digunakan di hari yang sama
4045501Bad RequestRequest header ada yang salah / kurang
4045501Unauthorized. Client Forbidden Access APIPartner tidak dapat mengakses api terkait